GET StateTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves state types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of state types to retrieve. Default is all state types |
integer |
None. |
skip |
Number of state types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the state types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of state types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of StateType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "StateTypeId": "d014c143-54d1-44e2-b880-699942309b49", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "af0cfcdc-e7a0-4717-9a05-07ea54a86f50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "860f7326-9337-46cf-a2b8-ae5ba553a10d", "CreateDate": "2024-04-28T05:41:51.4286661-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T05:41:51.4286661-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c88a8697-2052-41aa-b8d5-dbacdb805758", "CreateDate": "2024-04-28T05:41:51.4286661-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T05:41:51.4286661-07:00", "LastModifiedUser": "sample string 6" }, { "StateTypeId": "d014c143-54d1-44e2-b880-699942309b49", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "af0cfcdc-e7a0-4717-9a05-07ea54a86f50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "860f7326-9337-46cf-a2b8-ae5ba553a10d", "CreateDate": "2024-04-28T05:41:51.4286661-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T05:41:51.4286661-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c88a8697-2052-41aa-b8d5-dbacdb805758", "CreateDate": "2024-04-28T05:41:51.4286661-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T05:41:51.4286661-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }